home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / ForCLI / RIVer.lha / RIVer / RIVer.doc < prev    next >
Encoding:
Text File  |  1992-12-24  |  7.2 KB  |  193 lines
  1.  
  2.                   __
  3.                  / ////
  4.           __    ///
  5.           \ \  ///        < < <<<  RIVer v2.00  >>> > >
  6.            \ \///
  7.             \__////       USER MANUAL - Release : 12-Nov-92
  8.  
  9.                 Copyright ©1991-1992 Chris P. Vandierendonck, [AmiSYS].
  10.  
  11.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12.  
  13.        Copyright Notice
  14.        ~~~~~~~~~~~~~~~~
  15.          RIVer is  released  as  FREEWARE, not excluding the copyright and
  16.          all  other  rights,  which  remain  with  the  author  Chris   P.
  17.          Vandierendonck. Permission is granted to freely  distribute  this
  18.          program and related files for non-commercial purposes only.  When
  19.          distributed, all files must be kept together, in  their  original
  20.          unmodified form.
  21.  
  22.          Prior written permission from  the  author  is  required  to  use
  23.          RIVer in commercial releases, on coverdisks or diskmagazines.  
  24.  
  25.          (AmigaDOS is a trademark of Commodore Amiga Inc.)
  26.  
  27.        Disclaimer
  28.        ~~~~~~~~~~
  29.          RIVer  is provided "AS IS", WITHOUT ANY WARRANTY to its  quality,
  30.          performance or fitness for a  particular  purpose.  In  no  event
  31.          shall the author be liable or responsible  to  the  user  or  any
  32.          other person, for any kind of damage caused by the  use  of  this
  33.          software.
  34.  
  35.          Suggestions, remarks and bug reports about this  program  can  be
  36.          send to the following address :
  37.  
  38.               Chris Vandierendonck
  39.               Koning Albertstraat 188
  40.             B-8210   VELDEGEM
  41.               BELGIUM
  42.  
  43.        Preface
  44.        ~~~~~~~
  45.          RIVer is a program to read the  embedded  version  ID  (hereafter
  46.          referred to as 'EVID') of  a  program  or  any  other  file  that
  47.          supports this ID. The principle of an EVID  was  introduced  with
  48.          AmigaDOS release  2.  Many  systemsoftware  supports  this  EVID,
  49.          along with other software (mostly commercial). 
  50.  
  51.          RIVer  isn't  intentended  as  a  replacement  for  the  AmigaDOS
  52.          command 'Version', but rather an  extension.  With  RIVer you can
  53.          attach the EVID as a filenote (comment) to  the  scanned  program
  54.          or  file.  RIVer  can also show the EVID in the form of a  table,
  55.          where each field of the EVID is clearly printed.
  56.  
  57.          RIVer is reentrant, so it can be made resident.
  58.  
  59.        System Requirements
  60.        ~~~~~~~~~~~~~~~~~~~
  61.          RIVer requires AmigaDOS v1.2 or higher.
  62.  
  63.  
  64.                                           RIVer v2.00 User Manual - Page 1
  65.  
  66.        EVID structure
  67.        ~~~~~~~~~~~~~~
  68.          The  standard  format (AmigaDOS)  of  an  EVID  structure  is  as
  69.          follows :
  70.  
  71.            $VER: <name> <version>.<revision> (<dd>.<mm>.<yy>)
  72.  
  73.          Field explanation -> <name>     : name of the program or file
  74.                               <version>  : major version number
  75.                               <revision> : minor version number
  76.                               <dd>       : creation day 
  77.                               <mm>       : creation month (numeric)
  78.                               <yy>       : creation year
  79.  
  80.          After this text sequence, most programs include a comment.
  81.  
  82.          All my programs support this EVID code,  but  the  structure  has
  83.          been extended. (This has no effect on the correct functioning  of
  84.          the AmigaDOS command 'Version'!).
  85.  
  86.          The extended format (AmiSYS format) is as follows :
  87.                               
  88.            $VER: <name> <version>.<revision> (<dd>.<mm>.<yy>/
  89.            <hh>:<mm>:<ss>/<devcode>) <comment>
  90.  
  91.          Field explanation -> <hh>      : hour created
  92.                               <mm>      : minutes of hour created
  93.                               <ss>      : seconds of hour created 
  94.                               <devcode> : code  used  in  development   of
  95.                                           program 
  96.                               <comment> : copyright notice 
  97.  
  98.        Program Usage  (Shell/CLI only)
  99.        ~~~~~~~~~~~~~
  100.         FORMAT : <fileName> [MARK] [TABLE] [VERSION]
  101.  
  102.        o RIVer arguments :
  103.  
  104.          ("?" gets the program format.)
  105.          
  106.          <fileName> : the name of the program or file to  be  scanned  for
  107.                       an  EVID  (if  it's necessary to find it, also  give
  108.                       the path).
  109.  
  110.          [MARK]     : if an EVID is present, then attach it as a  filenote
  111.                       to the scanned program or file (if the EVID text  is
  112.                       longer  than  80  characters, then only the first 80
  113.                       characters will be used for the filenote).
  114.  
  115.          [TABLE]    : show the EVID in the form of  a  table,  where  each
  116.                       field of the  EVID  structure  is  clearly  printed.
  117.                       (See further for an example output.)
  118.  
  119.          [VERSION]  : print the program's copyright and version.
  120.  
  121.        o RIVer output :
  122.  
  123.          When the TABLE option isn't used, then  RIVer will only print the
  124.          EVID  text. If you type 'RIVer river' (if the RIVer program is in
  125.          the current directory, otherwise add the path to  find  it),  you
  126.  
  127.  
  128.                                           RIVer v2.00 User Manual - Page 2
  129.  
  130.          should get: "EVID: RIVer 2.00  (12.11.92/23:54:51/00-015)  ©1991-
  131.          1992 AmiSYS_[cpv]".
  132.  
  133.          The TABLE output should look like this ('RIVer river TABLE'):
  134.  
  135.            EMBEDDED VERSION ID
  136.            ~~~~~~~~~~~~~~~~~~~
  137.            FILENAME : RIVer
  138.            VERSION  : 2.00 
  139.            REL.DATE : 12.11.92
  140.            REL.TIME : 23:54:51
  141.            DEVCODE  : 00-015
  142.            COMMENT  : ©1991-1992 AmiSYS_[cpv]
  143.  
  144.  
  145.  
  146.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  147.         Program antecedents
  148.         ~~~~~~~~~~~~~~~~~~~
  149.          VERS RELEASED  RC COMMENT
  150.          ==== ========= == =============================================
  151.          1.00 16-Aug-91 PU First program version.
  152.          1.10 21-Feb-92 PU Made the code more  efficient.  Also  changed
  153.                            the output a bit.
  154.          1.11 29-Mar-92 PU Minor code changes.
  155.          2.00 12-Nov-92 FW Rewrote the program in  order  to  have  more
  156.                            efficient and faster code.
  157.                            Added the [TABLE] option.
  158.  
  159.        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  160.        RIVer v2.00, Copyright ©1991-1992 Chris P.Vandierendonck [AmiSYS], 
  161.                     All Rights Reserved.
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.                                           RIVer v2.00 User Manual - Page 3
  193.